Name | Description | Data Type |
AttributeSet | string indicating the Attribute set to be used for the point. Defaults to the empty string when creating a new point. | string |
DataLen | is a read-only integer that contains the length of the data. The value is configured by setting the Point Type ID | integer |
DataType | | CimPointTypesEnum |
DeadBand | is a variant with a string representation of 10 characters or less. Larger values will be rejected. Enter a value defining the tolerance for alarm conditions in this field. The deadband cushions the generation of alarms when a point value fluctuates at an alarm limit. Defaults to the empty string for new points. To remove the deadband set it to an empty string (e.g. "".) | string |
DerivedPoint | Contains the properties pertaining to Derived Point Configuration | CimDerivedPoint |
DerivedPoint\CalculationType | Specifies calculation types of points | CimPointCalcTypesEnum |
DerivedPoint\InitState | Specifies initial value for a global or derived point. | CimDpInitStateEnum |
DerivedPoint\InitValue | is string containing the initial value for the point. | string |
DerivedPoint\Local | is boolean indicating if the point is local. Local points can be used to hold intermediate values of expressions. The value of local points are not available to applications, they are only used internally by the derived point process to perform calculations. | boolean |
DerivedPoint\PointExpression | is string containing the expression for the point. | string |
DerivedPoint\PointSetInterval | is string containing the interval to update the timer counter point. The format is HH:MM:SS using a 24 hour clock. | string |
DerivedPoint\PointSetTime | is string containing the start time for the timer counter point. The format is HH:MM:SS using a 24 hour clock | string |
DerivedPoint\ProcessID | is a string specifying the derived point process supporting this point. Normally this will be 'SPM' or '_PTDP_RP'. This must identify a valid derived point processor process ID. It should not be changed unless you are using structure point processing | string |
DerivedPoint\ResetPointID | is a string containing the name of the reset point. | string |
DerivedPoint\RolloverVal | is a long integer defining the roll over value for delta accumulator function. | integer |
DerivedPoint\VarianceValue | is long integer defining the maximum variance value to be used for delta accumulator functions. | integer |
Description | is a mixed case string of 40 characters or less. Longer strings will be automatically truncated. Descriptions also appear as the tool-tip for the point when browsing or configuring points. Defaults to the empty string when creating a new point. | string |
DevicePoint | object contains the device information for a CIMPLICITY point. | CimDevicePoint |
DevicePoint\Address | is a string indicating the device specific address of the point | string |
DevicePoint\AddressOffset | is an integer indicating the address offset of the point. Typically used for addressing a boolean point in an analog domain | integer |
DevicePoint\AddressType | MMS types | CimMMSAddressTypeEnum |
DevicePoint\AnalogDeadband | is an variant containing the analog deadband for the point. The point will not be updated until a change that exceeds the deadband is read. | string |
DevicePoint\DelayLoad | is boolean indicating the point should only be loaded into memory if it's requested by an application. Defaults to False. | boolean |
DevicePoint\DeviceID | is a string indicating the device the point is on | string |
DevicePoint\JustInTime | is a boolean used to enable or disable Just-In-Time. Note this is only available when this is a class Data Item comming from the Class configuration | boolean |
DevicePoint\PollAfterSetpoint | is boolean indicating if the point should be polled immediately after a setpoint. If False, the point is not polled until the next scheduled scan cycle | boolean |
DevicePoint\ScanRate | is an integer indicating the scan rate of the point in multiples of the base scan rate of the communications port. | integer |
DevicePoint\TriggerType | defines the trigger condition for a device point. See the Point Configuration documentation for additional information | CimDeviceTriggerEnum |
DevicePoint\TriggerValue | is variant containing the trigger value. Trigger value is used when specifying a CimDevicePoint.TriggerType relation that requires a value | string |
DevicePoint\UpdateCriteria | defines update criterias available for device points. The particular types of update that are actually available depend on the device communication module being used | CimUpdateCriteriaEnum |
DisplayFormat | is a string used to specify the display format for the point. DisplayFormat uses the "C" language format specifiers | string |
DisplayLimitHigh | is a variant with a string representation of 10 characters or less. Larger values will be rejected. Display limits can be used as the animation limits when graphically displaying a point. Defaults to the empty string when creating a new point. To remove a limit set it to an empty string (e.g. "".) | string |
DisplayLimitLow | is a variant with a string representation of 10 characters or less. Larger values will be rejected. Display limits can be used as the animation limits when graphically displaying a point. Defaults to the empty string when creating a new point. To remove a limit set it to an empty string (e.g. "".) | string |
Elements | is an integer containing the number of elements in the point. Defaults to 1 for new points | integer |
EngineeringUnits | object contains the conversion information for converting a point from raw device units to real-world units. Conversion can either be linear or based on a conversion expression | CimEngineeringUnits |
EngineeringUnits\EuExpression | is a string containing the equation used to convert the value from device units to engineering units. To use a custom expression you must first disable the linear conversion for the object. If the point is not read-only a reverse expression must be specified to allow a setpoint in engineering units to be translated back to device units. It is your responsibility to make sure these expressions yield the correct results | string |
EngineeringUnits\EuLabel | is a string containing the EuLabel. Note you cannot specify an EuLabel if using a measurement unit for the point | string |
EngineeringUnits\EuRevExp | is a string containing the equation used to convert the value from engineering units to device units. To use a custom expression you must first disable the linear conversion for the object. A forward expression must also be specified. It is your responsibility to make sure these expressions yield the correct results | string |
EngineeringUnits\HighConvValue | is a variant containing the high converted value used for linear conversion with a string representation of 10 characters or less. Larger values will be rejected. To use linear conversion you must set linear conversion to True | string |
EngineeringUnits\HighRawValue | is a variant containing the upper raw value used for linear conversion with a string representation of 10 characters or less. Larger values will be rejected. To use linear conversion you must set linear conversion to True | string |
EngineeringUnits\LinearConversion | is a boolean indicating if the conversion is linear or custom | boolean |
EngineeringUnits\LowConvValue | is a variant containing the low converted value used for linear conversion with a string representation of 10 characters or less. Larger values will be rejected. To use linear conversion you must set linear conversion to True. | string |
EngineeringUnits\LowRawValue | is a variant containing the low raw value used for linear conversion with a string representation of 10 characters or less. Larger values will be rejected. To use linear conversion you must set linear conversion to True. | string |
EnterprisePoint | is an boolean indicating if the point should be exported to an enterprise server. Defaults to False when creating a new point | boolean |
EnumFields | As an alternative to the EnumerationID all the fileds used for this point may be provided, and an enumeration for this point will be generated | Array[CimPointEnumField] |
EnumerationID | is a string indicating the Point Enumeration to be used for the point. Defaults to the empty string when creating a new point. | string |
EuExists | is a boolean indicating if the point uses EU Conversion. Setting this to False will remove EU Conversion for the point. Setting this to True will enable EU Conversion for the point. Defaults to False for a new point | boolean |
Expressions | is a list that contains the expressions for this dataitem | Array[CimClassDataItemExpression] |
Extra | is an integer representing the extra data for the point. Defaults to 0 when creating a new point | integer |
InvertAvailabilityTrigger | is a boolean used to enable or disable availability trigger value inversion for a point. Defaults to FALSE for a new point | boolean |
Level | is an integer representing the level for the point. Defaults to 0 when creating a new point | integer |
LogData | is a boolean value indicating whether the point is logged through the database logger default logging option (DATA_LOG). To log the point to a table other than the default, use the CimTable methods. Defaults to the false when creating a new point | boolean |
LogDataHistorian | is a boolean value indicating whether the point is logged through Historian. Note The Historian OPC Interface option must be selected in the project properties. and the Historian client must be installed and configured. Defaults to the false when creating a new point | boolean |
MeasurementUnitID | is a string indicating the Measurement Unit ID to be used for conversion of the point. Defaults to the empty string when creating a new point | string |
MeasurementUnit | Represents measurement unit. | CimMeasurementUnit |
MeasurementUnit\UnitId | The string identifier of the measurement unit. | string |
MeasurementUnit\Description | Contains informative information about the measurement unit. | string |
MeasurementUnit\FullName | Contains the full name of the measurement unit such as ”hour” or ”meter per second”. | string |
MeasurementUnit\DisplayLabel | The display label of the measurement unit is typically the abbreviation of the measurement unit, for example ”h” for hour or ”m/s” for meter per second. | string |
MeasurementUnit\NamespaceUri | Identifies the organization (company, standards organization) that defines the measurement unit. | string |
MeasurementUnit\NumericUnitId | Numeric identifier for programmatic evaluation. -1 is used if a unitId is not available. | integer |
OPCUA_NodeID | is a read-only string containing the OPC UA NodeID for the point | string |
PointAlarm | object contains the point alarm information for a CIMPLICITY point | CimPointAlarm |
PointAlarm\Alarm | object provides an interface to CIMPLICITY Alarm configuration | CimAlarm |
PointAlarm\Alarm\AckTimeout | is a long integer that indicates when automatic alarm acknowledgement should happen. Valid values are -1 - Immediate Acknowledgement 0 - No Automatic Acknowledgement (default) >0 - Number of minutes to wait before automatically acknowledging alarm | integer |
PointAlarm\Alarm\AlarmClass | is a string containing the class of the alarm | string |
PointAlarm\Alarm\AlarmDescription | is a string containing the description of the alarm, This attribute shall be ignored in case of point alarm | string |
PointAlarm\Alarm\AlarmID | is a string containing the Alarm ID. When accessed from a Point Alarm, this property is read-only because the Alarm ID is the same as the Point ID | string |
PointAlarm\Alarm\AlarmMessage | is a string containing the alarm message. Note When accessed from a Point Alarm, this property is read-only because the structure of the point alarm message defines the alarm message | string |
PointAlarm\Alarm\AlarmTypeID | is a string containing the alarm type id of the alarm. When accessed from a Point Alarm, this property is read-only because the structure of the point alarm message defines the Alarm Type Id | string |
PointAlarm\Alarm\Changeapproval | defines different change approval data setting. The numeric value of these enumerations can be used in an expression of a class data item for the $APPROVAL_TYPE field | CimChangeapprovalEnum |
PointAlarm\Alarm\DeleteOpt | defines the deletion options available for an alarm | CimAlarmDelOptEnum |
PointAlarm\Alarm\HelpFileName | is a string containing the name of the alarm help file. The string must be prefixed with AM_HELP:\ in order for the file to be found by the alarm viewer and must have the extension HLP. | string |
PointAlarm\Alarm\HiAckTimeout | The CimAlarm.HiAckTimeout is a long integer that indicates when automatic alarm acknowledgement should happen while the alarm in the Warning High state. Valid values are -1 - Immediate Acknowledgement 0 - No Automatic Acknowledgement (default) >0 - Number of minutes to wait before automatically acknowledging alarm | integer |
PointAlarm\Alarm\HiDeleteOpt | defines the deletion options available for an alarm | CimAlarmDelOptEnum |
PointAlarm\Alarm\HiHiAckTimeout | The CimAlarm.HiHiAckTimeout is a long integer that indicates when automatic alarm acknowledgement should happen while the alarm in the Alarm High state. Valid values are -1 - Immediate Acknowledgement 0 - No Automatic Acknowledgement (default) >0 - Number of minutes to wait before automatically acknowledging alarm | integer |
PointAlarm\Alarm\HiHiDeleteOpt | defines the deletion options available for an alarm | CimAlarmDelOptEnum |
PointAlarm\Alarm\HiHiLogOpt | The CimAlarm.HiHiLogOpt is a string that indicates what the alarm transitions in the Alarm High state should be logged. Valid characters are A - Log when acknowledged R - Log when reset D - Log when deleted G - Log when generated | string |
PointAlarm\Alarm\HiHiRepeatTimeout | is a long integer that indicates when automatic alarm repeat should occur while the alarm is in the Alarm High state. 0 - No Automatic Repeat (default) >0 - Number of minutes to wait before automatically repeating alarm | integer |
PointAlarm\Alarm\HiHiResetAllowed | is a boolean that indicates if the alarm can be manually reset when it is in the Alarm High state | boolean |
PointAlarm\Alarm\HiHiResetTimeout | The CimAlarm.HiHiResetTimeout is a long integer that indicates when automatic alarm reset should happen while the alarm in the Alarm High state. Valid values are -1 - Immediate reset 0 - No Automatic reset (default) >0 - Number of minutes to wait before automatically resetting alarm | integer |
PointAlarm\Alarm\HiLogOpt | The CimAlarm.HiLogOpt is a string that indicates what the alarm transitions in the Warning High state should be logged. Valid characters are A - Log when acknowledged R - Log when reset D - Log when deleted G - Log when generated | string |
PointAlarm\Alarm\HiRepeatTimeout | is a long integer that indicates when automatic alarm repeat should occur while the alarm is in the Warning High state. 0 - No Automatic Repeat (default) >0 - Number of minutes to wait before automatically repeating alarm | integer |
PointAlarm\Alarm\HiResetAllowed | is a boolean that indicates if the alarm can be manually reset when it is in the Warning High state | boolean |
PointAlarm\Alarm\HiResetTimeout | The CimAlarm.HiResetTimeout is a long integer that indicates when automatic alarm reset should happen while the alarm in the Warning High state. Valid values are -1 - Immediate reset 0 - No Automatic reset (default) >0 - Number of minutes to wait before automatically resetting alarm | integer |
PointAlarm\Alarm\LoAckTimeout | is a long integer that indicates when automatic alarm acknowledgement should happen while the alarm in the Warning Low state. Valid values are -1 - Immediate Acknowledgement 0 - No Automatic Acknowledgement (default) >0 - Number of minutes to wait before automatically acknowledging alarm. | integer |
PointAlarm\Alarm\LoDeleteOpt | defines the deletion options available for an alarm | CimAlarmDelOptEnum |
PointAlarm\Alarm\LoLoAckTimeout | is a long integer that indicates when automatic alarm acknowledgement should happen while the alarm in the Alarm Low state. Valid values are -1 - Immediate Acknowledgement 0 - No Automatic Acknowledgement (default) >0 - Number of minutes to wait before automatically acknowledging alarm | integer |
PointAlarm\Alarm\LoLoDeleteOpt | defines the deletion options available for an alarm | CimAlarmDelOptEnum |
PointAlarm\Alarm\LoLoLogOpt | is a string that indicates what the alarm transitions in the Alarm Low state should be logged. Valid characters are A - Log when acknowledged R - Log when reset D - Log when deleted G - Log when generated | string |
PointAlarm\Alarm\LoLoRepeatTimeout | is a long integer that indicates when automatic alarm repeat should occur while the alarm is in the Alarm Low state. 0 - No Automatic Repeat (default) >0 - Number of minutes to wait before automatically repeating alarm | integer |
PointAlarm\Alarm\LoLoResetAllowed | is a boolean that indicates if the alarm can be manually reset when it is in the Alarm Low state | boolean |
PointAlarm\Alarm\LoLoResetTimeout | The CimAlarm.LoLoResetTimeout is a long integer that indicates when automatic alarm reset should happen while the alarm in the Alarm Low state. Valid values are -1 - Immediate reset 0 - No Automatic reset (default) >0 - Number of minutes to wait before automatically resetting alarm | integer |
PointAlarm\Alarm\LoLogOpt | The CimAlarm.LoLogOpt is a string that indicates what the alarm transitions in the Warning Low state should be logged. Valid characters are A - Log when acknowledged R - Log when reset D - Log when deleted G - Log when generated | string |
PointAlarm\Alarm\LoRepeatTimeout | is a long integer that indicates when automatic alarm repeat should occur while the alarm is in the Warning Low state. 0 - No Automatic Repeat (default) >0 - Number of minutes to wait before automatically repeating alarm | integer |
PointAlarm\Alarm\LoResetAllowed | is a boolean that indicates if the alarm can be manually reset when it is in the Warning Low state | boolean |
PointAlarm\Alarm\LoResetTimeout | is a long integer that indicates when automatic alarm reset should happen while the alarm in the Warning Low state. Valid values are -1 - Immediate reset 0 - No Automatic reset (default) >0 - Number of minutes to wait before automatically resetting alarm | integer |
PointAlarm\Alarm\LogOpt | The CimAlarm.LogOpt is a string that indicates when the alarm should be logged. Valid characters are A - Log when acknowledged R - Log when reset D - Log when deleted G - Log when generated | string |
PointAlarm\Alarm\MaxStacked | is a long integer that indicates how many alarms to stack. Defaults to zero if not specified. Maximum value is 20 | integer |
PointAlarm\Alarm\Published | is a boolean used to enable or disable publishing to SOA for an alarm. Defaults to FALSE for a new alarm | boolean |
PointAlarm\Alarm\RepeatTimeout | is a long integer that indicates when automatic alarm repeat should occur 0 - No Automatic Repeat (default) >0 - Number of minutes to wait before automatically repeating alarm | integer |
PointAlarm\Alarm\ResetAllowed | is a boolean that indicates if the alarm can be manually reset | boolean |
PointAlarm\Alarm\ResetTimeout | The CimAlarm.ResetTimeout is a long integer that indicates when automatic alarm reset should happen. Valid values are -1 - Immediate reset 0 - No Automatic reset (default) >0 - Number of minutes to wait before automatically resetting alarm | integer |
PointAlarm\Alarm\Routing | returns an object containing the alarm routing for the alarm | Array[string] |
PointAlarm\Alarm\Severity | is a short that indicates the alarm severity | integer |
PointAlarm\AlarmConfigured | is a boolean indicating if alarming is configured for the point | boolean |
PointAlarm\AlarmCriteria | defines types of alarming available | CimPointAlarmEnum |
PointAlarm\AlarmDelay | is a boolean indicating if the alarm generation should be delayed. When alarm delay is enabled specify the TimeInterval and TimeUnit for the delay. AlarmDelay cannot be used with a Rate of Change alarm criteria | boolean |
PointAlarm\AlarmHigh | contains a variant indicating the alarm high limit for the point | string |
PointAlarm\AlarmLow | contains a variant indicating the alarm low limit for the point | string |
PointAlarm\AlarmMessage | is a string containing the point alarm message to be used when an alarm is generated for the point | string |
PointAlarm\AlarmOffDelay | is a boolean indicating if the moving alarm to normal state should be delayed. When alarm off delay is enabled specify the TimeInterval and TimeUnit for the delay. AlarmOffDelay cannot be used with a Rate of Change alarm criteria | boolean |
PointAlarm\AlarmStrID | is a integer containing the Alarm String to use when generating point alarms. Defaults to 1 | integer |
PointAlarm\AlarmValueUpdate | is a boolean indicating if the %VAL field in the alarm message should be updated while the point is in ana alarm state | boolean |
PointAlarm\DeviationPtID | is a string containing the name of the deviation point. The deviation point must be specified when the alarm criteria is cimAlarmDeviation | string |
PointAlarm\HiDelayInterval | is a variant containing a numeric value indicating the delay interval when alarm goes into the Warning High state | string |
PointAlarm\HiDelayUnit | defines units for time values | CimTimeUnitEnum |
PointAlarm\HiHiDelayInterval | is a variant containing a numeric value indicating the delay interval when alarm goes into the Alarm High state | string |
PointAlarm\HiHiDelayUnit | defines units for time values | CimTimeUnitEnum |
PointAlarm\HiHiOffDelayInterval | is a variant containing a numeric value indicating the delay interval when alarm goes from the Alarm High state to Normal state | string |
PointAlarm\HiHiOffDelayUnit | defines units for time values | CimTimeUnitEnum |
PointAlarm\HiOffDelayInterval | is a variant containing a numeric value indicating the delay interval when alarm goes from the Warning High state to Normal state | string |
PointAlarm\HiOffDelayUnit | defines units for time values | CimTimeUnitEnum |
PointAlarm\LoDelayInterval | is a variant containing a numeric value indicating the delay interval when alarm goes into the Warning Low state | string |
PointAlarm\LoDelayUnit | defines units for time values | CimTimeUnitEnum |
PointAlarm\LoLoDelayInterval | is a variant containing a numeric value indicating the delay interval when alarm goes into the Alarm Low state | string |
PointAlarm\LoLoDelayUnit | defines units for time values | CimTimeUnitEnum |
PointAlarm\LoLoOffDelayInterval | is a variant containing a numeric value indicating the delay interval when alarm goes from the Alarm Low state to Normal State | string |
PointAlarm\LoLoOffDelayUnit | defines units for time values | CimTimeUnitEnum |
PointAlarm\LoOffDelayInterval | is a variant containing a numeric value indicating the delay interval when alarm goes from the Warning Low state to Normal state | string |
PointAlarm\LoOffDelayUnit | defines units for time values | CimTimeUnitEnum |
PointAlarm\TimeInterval | is a variant containing a numeric value indicating the time interval when using a rate of change or alarm delay | string |
PointAlarm\TimeUnit | defines units for time values | CimTimeUnitEnum |
PointAlarm\WarningHigh | contains a variant indicating the warning high limit for the point | string |
PointAlarm\WarningLow | contains a variant indicating the warning low limit for the point | string |
PointID | is a string that contains the name of the point. Point ID's are truncated to 256 characters. Since this is the default property of the object, you can omit it when assigning or using it. | string |
PointState | is a boolean used to enable or disable a point. When a point is disabled it is not collected from the device and is unavailable. The point is enabled when its point state is True, disabled when its point state is False. Defaults to True for new points | boolean |
PointTypeID | is a string containing the Point Type of the Point. Any of the point types that are available in configuration can be used here such as UINT, USINT, INT, SINT, STRING_20, etc. Must be specified when creating a new point | string |
Published | is a boolean used to enable or disable publishing to SOA for a point. Defaults to FALSE for a new point | boolean |
RangeLimitHigh | is a variant with a string representation of 10 characters or less. Larger values will be rejected. Values below the low range limit and above the high range limit will cause the point to be unavailable. Defaults to the empty string when creating a new point. To remove a limit set it to an empty string (e.g. "".) | string |
RangeLimitLow | is a variant with a string representation of 10 characters or less. Larger values will be rejected. Values below the low range limit and above the high range limit will cause the point to be unavailable. Defaults to the empty string when creating a new point. To remove a limit set it to an empty string (e.g. "".) | string |
ReadOnly | is an boolean indicating if the point is read-only. Defaults to False for new points | boolean |
ResourceID | is a string containing the Factory Resource associated with the point. Must be specified when creating a new point | string |
SafetyPointID | is an string containing the name of the safety point. The status of a safety point controls whether or not a setpoint is permitted. If the value of the safety point is non-zero and available a setpoint will be permitted. Defaults to the empty string when creating a new point. | string |
ScreenID | is a string indicating the CimView screen to be associated with the point. Defaults to the empty string when creating a new point | string |
SetpointLimitHigh | is a variant representing the upper limit for a value when performing a setpoint action with a string representation of 10 characters or less. Larger values will be rejected. Defaults to the empty string when creating a new point. To remove a limit set it to an empty string (e.g. "".) | string |
SetpointLimitLow | is a variant representing the lower limit for a value when performing a setpoint action with a string representation of 10 characters or less. Larger values will be rejected. Defaults to the empty string when creating a new point. To remove a limit set it to an empty string (e.g. "".) | string |
TrendBuffering | object contains the trend point buffering information for a CIMPLICITY point | CimTrendPtBuffer |
TrendBuffering\Duration | is a long integer containing maximum age in seconds of a sample to keep | integer |
TrendBuffering\MaxBuffered | is a long integer containing the maximum number of samples to keep | integer |
TriggerCheckPointID | is an string containing the name of the availability trigger for the point. When the availability trigger is non-zero and available the point will be available, otherwise the point is unavailable. Defaults to the empty string when creating a new point | string |
TriggerPointID | is a string indicating the name of the trigger point. Trigger points are valid only for device points and some derived points. When configured for a device point, the trigger point must be on the same device as the point you are defining. Defaults to the empty string when creating a new point | string |
Type | defines the orgin types for a point | CimPointOriginEnum |
changeapproval | defines different change approval data setting. The numeric value of these enumerations can be used in an expression of a class data item for the $APPROVAL_TYPE field | CimChangeapprovalEnum |